package com.share.common.log.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.share.common.log.enums.BusinessType;
import com.share.common.log.enums.OperatorType;

/**
 * 自定义操作日志记录注解
 * 基于AOP+注解实现 自动记录操作的日志，将业务代码解耦，增加复用性
 */
@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {
    /**
     * 执行操作所用的模块
     */
    public String title() default "";

    /**
     * 操作的类型 例如 增加 删除 修改等
     */
    public BusinessType businessType() default BusinessType.OTHER;

    /**
     * 操作人类别 例如 管理员 普通用户等
     */
    public OperatorType operatorType() default OperatorType.MANAGE;

    /**
     * 是否保存请求的参数
     */
    public boolean isSaveRequestData() default true;

    /**
     * 是否保存响应的参数
     */
    public boolean isSaveResponseData() default true;

    /**
     * 排除指定的请求参数
     */
    public String[] excludeParamNames() default {};
}
